package top.tangyh.basic.base.service;

import com.baomidou.mybatisplus.core.conditions.Wrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import top.tangyh.basic.base.entity.SuperEntity;
import top.tangyh.basic.base.manager.SuperManager;

import java.io.Serializable;
import java.util.Collection;
import java.util.List;

/**
 * 业务层
 *
 * @param <Id>        ID
 * @param <Entity>    实体
 * @param <SaveVO>    保存VO
 * @param <UpdateVO>  修改VO
 * @param <PageQuery> 分页查询参数
 * @param <ResultVO>  返回VO
 * @author zuihou
 * @date 2020年03月03日20:49:03
 */
@SuppressWarnings("ALL")
public interface SuperService<Id extends Serializable, Entity extends SuperEntity, SaveVO, UpdateVO, PageQuery, ResultVO> {

    /**
     * 获取实体的类型
     *
     * @return
     */
    Class<Entity> getEntityClass();

    Class<Id> getIdClass();

    SuperManager<Entity> getSuperManager();

    /**
     * 插入一条记录（选择字段，策略插入）
     *
     * @param entity 实体对象
     * @return 是否插入成功
     */
    Entity save(SaveVO entity);

    /**
     * 批量保存
     *
     * @param saveList
     * @return
     */
    boolean saveBatch(List<Entity> saveList);

    /**
     * 复制一条记录（选择字段，策略插入）
     *
     * @param entity 实体对象
     * @return 复制后的实体
     */
    Entity copy(Id id);

    /**
     * 根据 ID 选择修改
     *
     * @param entity 实体对象
     * @return 是否修改成功
     */
    Entity updateById(UpdateVO entity);

    /**
     * 根据id修改 entity 的所有字段
     *
     * @param entity 实体对象
     * @return 是否修改成功
     */
    Entity updateAllById(UpdateVO entity);

    /**
     * 删除（根据ID 批量删除）
     *
     * @param idList 主键ID列表
     * @return 是否删除成功
     */
    boolean removeByIds(Collection<Id> idList);

    /**
     * 根据 ID 查询
     *
     * @param id 主键ID
     */
    Entity getById(Id id);

    /**
     * 查询列表
     *
     * @param queryWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper}
     */
    List<Entity> list(Wrapper<Entity> queryWrapper);

    /**
     * 批量查询
     *
     * @param ids 主键
     * @return
     */
    List<Entity> listByIds(List<Id> ids);


    /**
     * 翻页查询
     *
     * @param page         翻页对象
     * @param queryWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper}
     */
    <E extends IPage<Entity>> E page(E page, Wrapper<Entity> queryWrapper);
}
